home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / utils / st-gui12.lzh / ST-GUIDE / DOK / ST-GUIDE.STG < prev   
Text File  |  1995-02-03  |  42KB  |  1,158 lines
  1. ##ACE-STGPAR 4 0004 
  2. @database "ST-Guide Dokumentation"
  3. @subject "Dokumentation/ST-Guide"
  4. @author "H. Weets, C. Wempe"
  5. ##CHANGED
  6. @$VER: st-guide.hyp 1.00 (@:"__DATE__")
  7. @help "Hilfsseite"
  8. @options +gz-s
  9.  
  10. @extern HCP "hcp.hyp/Main"
  11. @extern 1stConv "1st_conv.hyp/Main"
  12. @extern PC-Conv "pc_conv.hyp/Main"
  13. @extern RefLink "reflink.hyp/Main"
  14. @extern STool "stool.hyp/Main"
  15. @extern MAN2STG "man2stg.hyp/Main"
  16.  
  17. @node Main "Dokumentation des ST-Guide"
  18. @next Main
  19. @prev Main
  20. @symbol r ST-Guide
  21.  
  22. Dokumentation zum Fairware-Hypertext-System.
  23.  
  24. @{Inhalt: ignore}
  25.  Allgemeines
  26.      Die Philosophie
  27.      @{"Die Vorteile" Link Vorteile}
  28.      Rechtliches
  29.      Verwendete Software
  30.      Konfiguration
  31.      @{Dateitypen link HCP.HYP/Dateitypen}
  32.      Danksagung
  33.  
  34.  Das Anzeigeprogramm ST-Guide
  35.      Knöpfe
  36.      Tastatur
  37.      @{"Der ST-Guide und das PureC-Help-ACC" link PureC}
  38.      @{"Der ST-Guide und das AV-Protokoll" link AVProtokoll}
  39.      @{"Der ST-Guide und der 1stGuide" link 1stGuide}
  40.  
  41.  Weitere Programme
  42.      Der Compiler HCP
  43.      Der Referenz-File Linker RefLink
  44.      Der Konverter 1stConv
  45.      Der Konverter PC-Conv
  46.      Das Utility STool
  47.      Der Manual-Page Konverter MAN2STG
  48. @endnode
  49.  
  50.  
  51. @node Philosophie
  52. @prev Philosophie
  53. @toc Main
  54.  
  55. Kein Mensch liest heute Anleitungen, weil sie zu lang, zu un-
  56. übersichtlich oder zu uninteressant sind, aber vor allem deshalb, weil
  57. man nie das findet, woran man gerade interessiert ist.
  58.  
  59. Abhilfe schafft hier ein Hypertext-System, denn der Leser bekommt den
  60. Text in übersichtlicher Form und in kleinen Häppchen präsentiert,
  61. insbesondere sind bei entsprechender Aufmachung des Textes alle Punkte
  62. schnell durch ein paar Mausklicks zu ereichen.
  63.  
  64. Wichtig scheint mir in diesem Zusammenhang auch die Tatsache, daß ein
  65. Hypertext in einer Form erzeugt werden kann, in der er den Fachmann nicht
  66. langweilt und den Anfänger nicht überfordert.
  67.  
  68. Natürlich gibt es auch noch andere Hypertext-Systeme für den ST, jedoch
  69. ist unseres
  70.   - völlig kostenlos und kann von jedermann verwendet werden
  71.   - das flexibelste und umfangreichste von allen.
  72.  
  73. So ein Hypertextsystem wie dieses ist natürlich nicht nur dafür geeignet,
  74. Dokumentationen und Online-Hilfen zu Programmen zu schreiben. Es ist genau
  75. so gut möglich, hiermit auch andere Texte zu schreiben. Sinnvoll ist dies
  76. bei jeder Art von Text, in dem Querverweise vorkommen. Besonders
  77. interessant sind natürlich Texte über das Betriebssystem, die
  78. Programmierung und die Benutzung des ST. Aber auch Themen aus anderen
  79. Sachgebieten, wie Biologie, Musik, Mathematik usw. sind durchaus denkbar.
  80. @endnode
  81.  
  82. @node Vorteile "Die Vorteile dieses Systems"
  83. @toc Main
  84. @{U}Anmerkung:@{0}
  85.   Dieser Teil der Dokumentation wurde mir freundlicherweise von Volker
  86.   Burggräf zu Verfügung gestellt.
  87.  
  88. Abgesehen vom grundsätzlichen Vorteil von Hypertexten - der Möglichkeit
  89. der Querverweise und Verzweigungen - besitzt der ST-Guide aber auch
  90. klare @{U}Vorteile gegenüber anderen Hypertext-Systemen:@{0}
  91.  
  92.   @{B}Davon profitieren Sie beim Lesen von Hypertexten:@{0}
  93.   - Umfangreiche Grafik-Fähigkeiten
  94.   - Geringer Speicherverbrauch auf der Diskette/Festplatte
  95.   - Geringer Speicherverbrauch im Arbeitsspeicher des Computers
  96.   - Benutzung sowohl als Accessory wie auch als Programm
  97.   - Sie können auch Hypertexte anderer Formate an den ST-Guide anpassen
  98.   - Weitgehende Tastatur-Bedienbarkeit (alternativ zur Maus)
  99.   - Mehrere Suchfunktionen, darunter auch Ähnlichkeitssuche
  100.   - Sogar aus normalen ASCII-Texten kann auf Hilfeseiten verzweigt werden
  101.   - wenn GDOS läuft, kann der Anzeige-Zeichensatz selbst ausgewählt werden
  102.   - das Programm STOOL katalogisiert alle Ihre Hypertexte automatisch
  103.   - Die Benutzung ist kostenlos (Fairware), aber Spenden sind erbeten
  104.  
  105.   @{B}Davon profitieren Sie, wenn Sie selbst Hypertexte schreiben wollen:@{0}
  106.   - leicht erlernbare Syntax der Befehle
  107.   - Verweise zu anderen Seiten werden vom Compiler @{U}automatisch@{0} erstellt!
  108.   - ein Index wird vom Compiler @{U}automatisch@{0} erstellt
  109.   - alle Seiten eines Hypertextes befinden sich in einer Datei (kompakt!)
  110.   - große Vielfalt der Gestaltungsmöglichkeiten
  111. @autorefoff
  112.   - der ST-Guide taugt als kontextabhängige Online-Hilfe für Programme
  113. @autorefon
  114.   - Einbindung der Original-RSC-Files von Programmen möglich
  115.   - der ST-Guide ist sehr verbreitet! (sehr gut, aber dennoch kostenlos!)
  116. @endnode
  117.  
  118.  
  119. @node Rechtliches
  120. @toc Main
  121.  
  122. @symbol ai Fairware
  123. Dieses Hypertext-System ist Fairware, d.h. jedermann kann es unbegrenzt
  124. lange kostenlos benutzen und an jede Person weitergeben, vorausgesetzt,
  125. daß die Weitergabe kostenlos ist. @{B}Bei regelmäßiger Benutzung sollte
  126. der Autor jedoch mit einer Spende bedacht werden, da nur so die
  127. Weiterentwicklung dieses Systems gewährleistet ist.@{0}
  128.  
  129. Der ST-Guide darf als Zusatz zu eigenen Programmpaketen weitergegeben
  130. werden, egal welcher Art diese sind, d.h. auch innerhalb von Shareware und
  131. kommerziellen Progammen, ohne daß hierfür Lizenzgebühren fällig werden
  132. (obwohl ein kleine Anerkennung in diesem Fall wohl mehr als fair wäre). Es
  133. muß aber ein Hinweis vorhanden sein, daß der ST-Guide Fairware und von mir
  134. ist.
  135.  
  136. Nett wäre es in diesem Fall, wenn mir eine Disk mit dem betreffenden
  137. Programm und dem zugehörigen Hypertext zugesand würde, quasi als
  138. Belegexemplar.
  139.  
  140. Da es der Hauptverwendungszweck des ST-Guide ist, Dokumentationen zu
  141. anderen Programmen zu schreiben, darf er in zwei Formen weitergegeben
  142. werden:
  143.  
  144.     a) Vollständig, als komplettes Programmpaket mit allen zugehörigen
  145.        Dateien. Diese Form ist auf jeden Fall vorzuziehen, auch wenn die
  146.        Weitergabe innerhalb eines anderen Programmpaketes erfolgt.
  147.  
  148.     b) Nur der Viewer und die Dokumentation, falls die Weitergabe
  149.        innerhalb eines anderen Programmpaketes erfolgt @{B}und@{b} eine
  150.        Dokumentation zu diesem Programm im Format des ST-Guide dabei
  151.        ebenfalls mitgeliefert wird.
  152.  
  153. Soweit die Weitergabe als Zugabe zu irgendwelchen Programmen oder durch
  154. PD-Händler erfolgt, erbitten wir eine kurze Mitteilung darüber, damit wir
  155.     a) abschätzen können, wie weit das Paket sich verbreitet, und
  156.     b) evtl. Auskunft über Updates geben können.
  157.  
  158. Natürlich sind wir auch sehr daran interessiert, zu sehen, in welchen
  159. Programmen der ST-Guide verwendet wird. Wem es also möglich ist, kann uns
  160. dann ja auch eine Kopie seines Programmes zukommen lassen.
  161.  
  162. @index Spenden
  163. Spenden: In diesem Programmpaket steckt inzwischen sehr viel Arbeit.
  164.          Trotzdem haben wir uns entschieden es als Fairware zu
  165.          veröffentlichen, um jedem zu ermöglichen, damit Dokumentationen
  166.          zu seinen Programmen zu schreiben. Es wäre aber nur fair, uns
  167.          eine kleine Anerkennung für unsere Arbeit zukommen zu lassen.
  168.          Auch kleine Spenden motivieren uns, auch in Zukunft noch an
  169.          diesem Projekt zu arbeiten, es zu erweitern und zu verbessern.
  170.  
  171. Kein Programm ist wirklich fehlerfrei, deshalb können und wollen wir
  172. keinerlei Garantien für die Lauffähigkeit oder Tauglichkeit dieses Paketes
  173. für irgendeinen Zweck übernehmen und können insbesondere nicht haftbar
  174. gemacht werden für irgendwelche Schäden, die durch die Benutzung dieses
  175. Paketes theoretisch entstehen könnten.
  176.  
  177. @Index "Holgers Adresse"
  178. @ALabel "Adresse"
  179. Für Lob, Kritik, Vorschläge und Spenden sind wir folgendermaßen
  180. erreichbar:
  181.                 Holger Weets
  182.                 Tangastrasse 45
  183.                 26121 Oldenburg
  184.                 E-Mail: Holger Weets @ OL (Mausnet)
  185.                 Bankverbindung:
  186.                 KTO: 023-182 041
  187.                 BLZ: 280 501 00
  188.                 Landessparkasse zu Oldenburg
  189.  
  190. Wer eine neue Version direkt von mir haben möchte, schicke bitte einen
  191. frankierten Rückumschlag und 10 Mark an diese Adresse. Dieser Betrag dient
  192. mir als Aufwandsentschädigung, denn schließlich habe ich auch etwas
  193. besseres zu tun als Disketten zu kopieren.
  194. @endnode
  195.  
  196.  
  197. @node "Verwendete Software"
  198. @toc Main
  199.  
  200. Folgende Programme wurden zur Implementierung dieses Systemes verwendet:
  201.  
  202. * @{U}SOZOBON V2.00x10@{u}
  203.     als C-Compiler System
  204.     Autoren: die SOZOBON-Leute, Christian Wempe und Holger Weets
  205.  
  206. * @{U}ACE@{u}
  207.     als Editor und Programmierumgebung
  208.     Autor: Holger Weets
  209.  
  210. * @{U}RED@{u}
  211.     als Resource-Editor
  212.     Autor: Holger Weets
  213.  
  214. * @{U}C-RSC@